Inscoper::RecipeElementGroup

RecipeElementGroup class represents a recipe element that holds other recipe elements. More...

#include <RecipeElementGroup.h>

Inherits from Inscoper::RecipeElement

Public Functions

	Name
	RecipeElementGroup() Default constructor.
virtual void	fromXML(Inscoper::XMLNode & xml) override Load from XML.
virtual void	toXML(Inscoper::XMLNode & xmlParent) override Save to XML.
virtual Inscoper::ERecipeElementType	getType() override Get the element type.
const std::string &	getRecipeName() const Get the recipe name.
void	setRecipeName(const std::string & recipeName) Set the recipe name.

Detailed Description

class Inscoper::RecipeElementGroup;

RecipeElementGroup class represents a recipe element that holds other recipe elements.

This element allows nesting recipes by defining a group that refers to another recipe.

Public Functions Documentation

function RecipeElementGroup

RecipeElementGroup()

Default constructor.

Initializes a new instance of the RecipeElementGroup class.

function fromXML

virtual void fromXML(
    Inscoper::XMLNode & xml
) override

Load from XML.

Parameters:

• xml : The XML node containing recipe element group

Exceptions:

• InscoperException If an error occurs

Reimplements: Inscoper::RecipeElement::fromXML

Populates the recipe element group from an XML node.

function toXML

virtual void toXML(
    Inscoper::XMLNode & xmlParent
) override

Save to XML.

Parameters:

• xmlParent : The parent XML node

Exceptions:

• InscoperException If an error occurs

Reimplements: Inscoper::RecipeElement::toXML

Exports the recipe element group to an XML node attached to the parent XML node.

function getType

virtual Inscoper::ERecipeElementType getType() override

Get the element type.

Return: The type (GROUP)

Reimplements: Inscoper::RecipeElement::getType

Retrieves the type of this recipe element (GROUP).

function getRecipeName

const std::string & getRecipeName() const

Get the recipe name.

Return: The recipe name

Retrieves the name of the recipe referenced by this group.

function setRecipeName

void setRecipeName(
    const std::string & recipeName
)

Set the recipe name.

Parameters:

• recipeName : The recipe name

Sets the name of the recipe referenced by this group.

---

Updated on 2026-04-02 at 10:55:36 +0200